docs: post-v1 accuracy and coverage update#3
Merged
Conversation
New pages:
- docs/cli/init.md — flaglint init command reference
- docs/cli/completion.md — flaglint completion command reference
Sidebar:
- astro.config.mjs: add init (before audit) and completion (after exit-codes) to CLI section
Accuracy fixes:
- supported-scope.md: React SDK hooks/HOC/provider now detected (was 'No')
Add React SDK detection section with import provenance examples
- configuration.md: document wrappers object form {import, function, flagKeyArgument}
with field table and false-positive prevention explanation
Changelog:
- changelog.md: add v1.1.0 block covering PRs #194-#200
(React SDK detection, wrapper v2, init, completion, --quiet/--verbose,
action version input, provider guard, micromatch)
Global flags on all command pages:
- scan.md, audit.md, migrate.md, validate.md: add --quiet/-q and --verbose rows
Quickstart:
- quickstart.md: add step 0 for flaglint init before step 1 (audit)
Signed-off-by: Krishan Kant Sharma <krishansharma0327@gmail.com>
📝 WalkthroughWalkthroughDocumentation-only changes to the Starlight docs site: added new CLI pages for ChangesDocumentation Updates
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/content/docs/docs/cli/completion.md`:
- Around line 55-59: The Fish completion install example in the completion docs
assumes ~/.config/fish/completions exists, which can break on a fresh machine.
Update the Fish section to add a mkdir -p step before running flaglint
completion fish, so the generated file can be redirected into an existing
completions directory.
In `@src/content/docs/docs/reference/supported-scope.md`:
- Line 12: Clarify the intro text in supported-scope.md so it is not
contradictory about React coverage. Update the section that mentions detection
coverage to explicitly state that React SDK hooks, HOC, and provider patterns
are an exception and are reported for manual review, while other non-Node SDKs
and non-LaunchDarkly providers remain out of scope. Use the existing
supported-scope intro wording as the place to revise.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 7ae91bf4-d51e-4bd8-bc34-ecf95ffefaa1
📒 Files selected for processing (11)
astro.config.mjssrc/content/docs/docs/cli/audit.mdsrc/content/docs/docs/cli/completion.mdsrc/content/docs/docs/cli/configuration.mdsrc/content/docs/docs/cli/init.mdsrc/content/docs/docs/cli/migrate.mdsrc/content/docs/docs/cli/scan.mdsrc/content/docs/docs/cli/validate.mdsrc/content/docs/docs/quickstart.mdsrc/content/docs/docs/reference/changelog.mdsrc/content/docs/docs/reference/supported-scope.md
Comment on lines
+55
to
+59
| ### Fish | ||
|
|
||
| ```bash | ||
| flaglint completion fish > ~/.config/fish/completions/flaglint.fish | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Create the Fish completions directory first.
~/.config/fish/completions/ is not guaranteed to exist, so this install command can fail on a fresh machine. Add a mkdir -p step before the redirect.
♻️ Proposed fix
### Fish
```bash
+mkdir -p ~/.config/fish/completions
flaglint completion fish > ~/.config/fish/completions/flaglint.fish
</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
### Fish
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/content/docs/docs/cli/completion.md` around lines 55 - 59, The Fish
completion install example in the completion docs assumes
~/.config/fish/completions exists, which can break on a fresh machine. Update
the Fish section to add a mkdir -p step before running flaglint completion fish,
so the generated file can be redirected into an existing completions directory.
| - legacy `launchdarkly-node-server-sdk` | ||
|
|
||
| Browser SDKs, React SDKs, non-Node SDKs, and non-LaunchDarkly providers are outside current detection coverage and do not appear in reports. | ||
| React SDK hooks, HOC, and provider are detected and reported for manual review. Browser SDKs, non-Node SDKs, and non-LaunchDarkly providers are outside current detection coverage and do not appear in reports. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Clarify the React SDK exception in the intro.
This reads as contradictory today: it says non-Node SDKs do not appear in reports, but the next sentence says React SDK patterns are reported for manual review. Readers may come away unsure whether React entries are covered.
♻️ Proposed fix
-React SDK hooks, HOC, and provider are detected and reported for manual review. Browser SDKs, non-Node SDKs, and non-LaunchDarkly providers are outside current detection coverage and do not appear in reports.
+React SDK hooks, HOC, and provider are detected and reported for manual review. Other browser SDKs and non-LaunchDarkly providers are outside current detection coverage and do not appear in reports.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| React SDK hooks, HOC, and provider are detected and reported for manual review. Browser SDKs, non-Node SDKs, and non-LaunchDarkly providers are outside current detection coverage and do not appear in reports. | |
| React SDK hooks, HOC, and provider are detected and reported for manual review. Other browser SDKs and non-LaunchDarkly providers are outside current detection coverage and do not appear in reports. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/content/docs/docs/reference/supported-scope.md` at line 12, Clarify the
intro text in supported-scope.md so it is not contradictory about React
coverage. Update the section that mentions detection coverage to explicitly
state that React SDK hooks, HOC, and provider patterns are an exception and are
reported for manual review, while other non-Node SDKs and non-LaunchDarkly
providers remain out of scope. Use the existing supported-scope intro wording as
the place to revise.
This was referenced Jul 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
flaglint initandflaglint completion— both commands shipped in v1.1.0 but had no documentationinit(before audit) andcompletion(after exit-codes) entries--quiet/--verboseadded to options tables on all four command pagesflaglint initadded as step 0Test plan
npm run buildpasses (66 pages, 0 errors — verified locally)initandcompletionpages render correctly in sidebar--quiet/--verboseappear in options tables on scan, audit, migrate, validateSummary by CodeRabbit
New Features
initandcompletioncommands to the CLI docs and navigation.Bug Fixes
Documentation
--quietand--verbose.